Skip to content

docs(readme): rewrite Quick Start as 5-minute onboarding walkthrough#144

Merged
vreshch merged 1 commit intomasterfrom
hardening/quickstart
Apr 20, 2026
Merged

docs(readme): rewrite Quick Start as 5-minute onboarding walkthrough#144
vreshch merged 1 commit intomasterfrom
hardening/quickstart

Conversation

@vreshch
Copy link
Copy Markdown
Contributor

@vreshch vreshch commented Apr 20, 2026

Summary

  • Closes MVP blocker build(deps): bump zod from 3.25.76 to 4.1.13 #5 — "5-minute quickstart missing." The previous Quick Start was a terse command reference; replaces it with a narrative walkthrough: install → author .agent.md → run → explore.
  • Anchors on the markdown path (no API key, no hub, no login) so a fresh reader can reach a first result with five commands.
  • Points at agentage create -t claude for a real LLM response and at the pr-list reference agent for a structured-output example.
  • No code changes.

Test plan

  • Walked the exact steps locally against @agentage/cli@0.19.0agentage agents discovers the markdown file, agentage run hello "Volodymyr" echoes the prompt + task.
  • Reader sanity check — can someone unfamiliar with the project follow it without hitting a wall?

Closes MVP blocker #5 (5-minute quickstart missing). Replaces the
terse command-reference Quick Start with a narrative walkthrough: npm
install → author .agent.md → agentage agents → agentage run → explore.

Covers both markdown-first path (echoes prompt+task, zero-config) and
the `agentage create -t claude` path for a real LLM response, plus a
pointer to the `pr-list` reference agent for a structured-output
example.
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Apr 20, 2026

🎉 PR Validation ✅ PASSED

Commit: 9e9cc8b58edd7a5d81c6d874ec9e4413397d5780
Branch: hardening/quickstart

Checks:

  • ✅ Release guard (no version/changelog changes)
  • ✅ Dependencies installed
  • ✅ Type check passed
  • ✅ Linting passed
  • ✅ Format check passed
  • ✅ Tests + coverage passed
  • ✅ Build successful

Ready to merge!


🔗 View workflow run
⏰ Generated at: 2026-04-20T20:55:49.532Z

@vreshch vreshch merged commit 803a75e into master Apr 20, 2026
1 check passed
@vreshch vreshch deleted the hardening/quickstart branch April 20, 2026 22:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant